update changelog.d format and Matrix link #10383
Conversation
|
It'd still have been a syntax change: originally it was space-separated. @fgaz changed the type for some reason when he rewrote https://codeberg.org/fgaz/changelog-d/pulls/13. |
...I don't think this ever happened?! In https://codeberg.org/fgaz/changelog-d/pulls/13 I never touched cd "$(mktemp -d)"
cat > entry1 <<EOF
packages: foo
synopsis: entry 1
EOF
cat > entry2 <<EOF
packages: [foo]
synopsis: entry 2
EOF
cat > config <<EOF
organization: org
repository: repo
EOF$ changelog-d-v1.0.1-x86_64-linux . --package foo
Errors encountered when parsing file ./entry2:
entry2:1:11: error:
unexpected '['
expecting white space or end of input
1 | packages: [foo]
| ^
$ rm entry2
$ changelog-d-v1.0.1-x86_64-linux . --package foo
- entry 1 |
|
I see what happened. That CI job ran against 49d2ab0, which includes a changelog entry in markdown format. The markdown format uses a YAML frontmatter, and YAML lists do require brackets when using the inline syntax. This was introduced in changelog-d#5 and does not affect cabal-formatted entries. The markdown example in the changelog-d readme was slightly incorrect, I just fixed it. In the future I may allow space-separated packages as it's done for issues and prs, though this is a breaking change. |
geekosaur
force-pushed
the
contributing-changelogs
branch
from
f03f5c4
to
888cf86
Compare
|
Documentation corrected and a note about Markdown format added. |
`changelog-d` was changed to make `packages` a list, so reflect this in the example. Also remove the "omit if it's an overarching change" part: we must list all packages if we want it to show up when generating release changelogs. While I was there, I updated the Matrix channel reference because it was still reflecting the EMS Libera bridge.
geekosaur
force-pushed
the
contributing-changelogs
branch
from
888cf86
to
1b42766
Compare
Co-authored-by: Artem Pelenitsyn <[email protected]>
geekosaur
added
squash+merge me
mergify
bot
added
ready and waiting
| synopsis: Add feature xyz | ||
| packages: [cabal-install] | ||
| prs: #0000 | ||
| issues: #0000 #0000 |
There was a problem hiding this comment.
Oh, this needs a followup: in YAML, # is a comment marker, so the changelog-d YAML format doesn't use the # in issue/PR numbers.
There was a problem hiding this comment.
I copied that from changelog-d's README; I guess that was what this was talking about.
changelog-dwas changed to makepackagesa list, so reflect this in the example. Also remove the "omit if it's an overarching change" part: we must list all packages if we want it to show up when generating release changelogs.While I was there, I updated the Matrix channel reference because it was still reflecting the EMS Libera bridge.
Template B: This PR does not modify behaviour or interface
E.g. the PR only touches documentation or tests, does refactorings, etc.
Include the following checklist in your PR: